Harlequin Toolkit
CLI
CLI

CLI Overview

The Harlequin CLI is a powerful command-line tool for building AO processes and working with Lua files.

Features

  • Project Initialization: Create new AO process projects from templates
  • Build System: Compile flavored AOS processes with WebAssembly output
  • Lua Utilities: Bundle and process Lua files for distribution
  • Version Management: Install, upgrade, and manage CLI versions
  • Remote Signing: WebSocket-based signing server for web interfaces
  • Interactive TUI: Guided workflows with real-time feedback
  • Configuration Management: Flexible configuration options

Quick Start

Interactive Mode (Recommended)

Launch the interactive TUI for guided workflows:

harlequin

Create a New Project

harlequin init

Build an AO Process

harlequin build --entrypoint main.lua

Bundle Lua Files

harlequin lua-utils bundle --entrypoint main.lua

Manage Versions

# List available versions
harlequin versions

# Install specific version
harlequin install --version v0.1.1

# Upgrade to latest
harlequin install

Available Commands

Command Description
init Create new AO process projects from templates
build Build AO applications with WebAssembly output
lua-utils Lua file utilities (bundle, etc.)
install Install or upgrade harlequin
uninstall Uninstall harlequin
versions List available versions
remote-signing Start remote signing server
version Show version information
help Show help information

Command Categories

Project Management

  • init - Create new AO process projects from templates (Lua, C, Rust, AssemblyScript)
  • Interactive wizard with template selection and project configuration

Version Management

  • install - Install or upgrade harlequin to specific versions
  • uninstall - Remove harlequin from your system
  • versions - List all available versions with multiple output formats

Build Commands

  • build - Compile AOS processes into WebAssembly binaries
  • Support for custom configurations, output directories, and debug modes

Lua Utils Commands

  • bundle - Combine multiple Lua files into a single executable
  • Automatic dependency resolution and circular dependency handling

Remote Signing

  • remote-signing - WebSocket-based signing server for web interfaces
  • Support for custom ports, hosts, and frontend URLs

Interactive TUI

  • Default mode - Guided workflows for all commands
  • File discovery, configuration editing, and real-time progress
  • Better development experience than CLI flags
ON THIS PAGE